Vcenter Vm Guest Filesystem Files ListResult

Vcenter Vm Guest Filesystem Files ListResult
Vcenter Vm Guest Filesystem Files ListResult

The Vcenter Vm Guest Filesystem Files ListResult schema describes the results of a POST /vcenter/vm/{vm}/guest/filesystem/files?action=list operation.

This schema was added in vSphere API 7.0.2.0.

JSON Example
{
    "files": [
        {
            "filename": "string",
            "type": "string",
            "size": 0
        }
    ],
    "total": 0,
    "start_index": 0,
    "end_index": 0,
    "status": "string"
}
array of Vcenter Vm Guest Filesystem Files Summary
files
Required

A list of Vcenter Vm Guest Filesystem Files Summary schemas containing information for all the matching files.

This property was added in vSphere API 7.0.2.0.

integer As int64 As int64
total
Required

The total number of results from the POST /vcenter/vm/{vm}/guest/filesystem/files?action=list. This is a hint to the user of the iterator regarding how many items are available to be retrieved. The total could change if the inventory of items are being changed.

This property was added in vSphere API 7.0.2.0.

integer As int64 As int64
start_index
Optional

Positional index into the logical item list of the first item returned in the list of results. The first item in the logical item list has an index of 0. This is a hint to the user of the iterator regarding the logical position in the iteration. For example, this can be used to display to the user which page of the iteration is being shown. The total could change if the inventory of items are being changed.

This property was added in vSphere API 7.0.2.0.

If missing or null no items were returned.

integer As int64 As int64
end_index
Optional

Positional index into the logical item list of the last item returned in the list of results. The first item in the logical item list has an index of 0. This is a hint to the user of the iterator regarding the logical position in the iteration. For example, this can be used to display to the user which page of the iteration is being shown. The total could change if the inventory of items are being changed.

This property was added in vSphere API 7.0.2.0.

If missing or null no items were returned.

string
status
Required

The last status for the iterator that indicates whether any more results can be expected if the caller continues to make requests for more data using the iterator.

For more information see: Vcenter Vm Guest Filesystem Files LastIterationStatus.

This property was added in vSphere API 7.0.2.0.

Returned By